Return Order Wrapper

Use this API to do multiple tasks in one go, namely creating a quick order, creating shipment, and finally assigning courier to the shipment.

This API integrates several other APIs to perform all these tasks together.

Task:

Create Return order
Create Return shipment
Run Internal serviceability check
Check Internal courier rule/priority
Assign awb
Schedule pickup

Basic Information

NAME	DETAILS
Usage:	Mandatory
URL:	`https://api.rapidshyp.com/rapidshyp/apis/v1/return_wrapper`
Request Type:	POST
Scheme:	HTTPS
Header (content-type):	`application/json`
Header (rapidshyp-token):	API-Key

Curl:

curl --location 'https://api.rapidshyp.com/rapidshyp/apis/v1/return_wrapper' \
--header 'rapidshyp-token: *************517' \
--header 'Content-Type: application/json' \
--data-raw '{
"orderId": "1111111111",
"orderDate": "2025-08-25",
"is_qc_enabled":true,
"pickupLocation": {
"pickup_customer_name": "DO EPIC SHISP",
"pickup_customer_last_name": "DO EPIC SHSIPP",
"pickup_email": "abc@gmail.com",
"pickup_phone": "9999999999",
"pickup_address": "abGGG",
"pickup_address_2": "GG",
"pickup_pincode": "110001"
},
"storeName": "",
"return_reason_code": "",
"deliveryAddress_name": "",
"deliveryAddress": {
"deliverylocation_name": "Abhinavqaqa",
"contact_name": "Abhinavqaqa",
"delivery_address1": "abxhA hhhhhhhhhhhhhd gggggggggg",
"delivery_address2": "abxAhd hhhhhhhhhhhhhh gggggb hhh h",
"pincode": "110001",
"delivery_email": "abc@gmail.com",
"delivery_phone": "9999999999"
},
"orderItems": [
{
"itemName": "ARPTEST0023",
"sku": "ARPTEST0023",
"units": 2,
"unitPrice": 50.0,
"tax": 0.0,
"hsn": "HSN456",
"productLength": 11.0,
"productBreadth": 12.0,
"productHeight": 12.0,
"productWeight": 3.0,
"brand": "",
"serial_no":"",
"imei_no":"",

"images_name":["https://i.pinimg.com/736x/14/ec/3f/14ec3ff15e3335264723fe39fb9da735.jpg"],
"color":"red",
"size":"L"

}

],
"packageDetails": {
"packageLength": 11.0,
"packageBreadth": 11.0,
"packageHeight": 11.0,
"packageWeight": 1000.0
},
"comment":"this is return api"
}'

Request Parameters	Required	Remark	Validation
orderId	Mandatory	Seller order ID on channel/store/website	Minimum 1 character
orderDate	Mandatory	Order created date on channel/store/website	Format: `YYYY-MM-DD`
pickupLocation
pickup_customer_name	Mandatory	Customer first name	The combined length of the first and last name in the pickup address must be between 3 and 75 characters.
pickup_customer_last_name	Non-Mandatory	Customer last name
pickup_email	Non-Mandatory	Customer email
pickup_phone	Mandatory	Customer phone number	Phone number must start from 6,7,8,9
pickup_address	Mandatory	Customer address line 1	Pickup address line 1 must be between 3 and 100 characters long
pickup_address_2	Non-Mandatory	Customer address line 2	If entered, Pickup address line 2 must be between 3 and 100 characters long
pickup_pincode	Mandatory	Customer address pincode	Must be 6-digit valid pincode
`},`
storeName	Mandatory	Store name created on Rapidshyp	By default, pass `"DEFAULT"`
return_reason_code	Non-Mandatory	If left blank, “others” is passed as return reason	Return reason code sheet attached below
deliveryAddress_name	Mandatory	Mapped delivery location (warehouse name)
`{`
deliveryAddress			Not required if a third party Warehouse location of Rapidshyp at their end.
deliverylocation_name			Not required if a third party Warehouse location of Rapidshyp at their end.
contact_name			Not required if a third party Warehouse location of Rapidshyp at their end.
delivery_address1			Not required if a third party Warehouse location of Rapidshyp at their end.
delivery_address2			Not required if a third party Warehouse location of Rapidshyp at their end.
pincode			Not required if a third party Warehouse location of Rapidshyp at their end.
delivery_email			Not required if a third party Warehouse location of Rapidshyp at their end.
delivery_phone
`},`
orderItems
`[`
`{`
itemName	Mandatory	Item Name	Order line item name must be between 3 and 200 characters long.
sku	Non-Mandatory	Item SKU Id	Order line item SKU must be between 3 and 200 characters long.
units	Mandatory	Quantity of items	Item quantity must be greater than 0 in items.
unitPrice	Mandatory	Unit price of SKU inclusive of Taxes
tax	Non-Mandatory	Tax	Pass 0 in case of zero tax item
hsn	Non-Mandatory	HSN code
productLength	Non-Mandatory	Product dimension length	In cm
productBreadth	Non-Mandatory	Product dimension breadth	In cm
productHeight	Non-Mandatory	Product dimension height	In cm
productWeight	Non-Mandatory	Product dimension weight	In gm
brand	Non-Mandatory	Brand name
packageDetails	Mandatory
packageLength	Mandatory	packageLength	In cm
packageBreadth	Mandatory	packageBreadth	In cm
packageHeight	Mandatory	packageHeight	In cm
packageWeight	Mandatory	packageWeight	In gm
`},`
comment	Non-Mandatory	Any custom comment
`}`

Note: Incase third party wants to send the exact reason for return,you need to create mapping between Rapidshyp status code and their own status code.

return_reason_code	return_reason_name
ITEM_DAMAGED	Item is damaged
WRONG_ITEM	Received wrong item
PARCEL_DAMAGED_ON_ARRIVAL	Parcel damaged on arrival
QUALITY_NOT_AS_EXPECTED	Quality not as expected
MISSING_ITEM	Missing item or accessories
PERFORMANCE_NOT_ADEQUATE	Performance not adequate
SIZE_NOT_AS_EXPECTED	Size not as expected
DOES_NOT_FIT	Does not fit
NOT_AS_DESCRIBED	Not as described
ARRIVED_TOO_LATE	Arrived too late
CHANGED_MY_MIND	Changed my mind
OTHER	Other

Response:

JSON
{
    "status": "SUCCESS",
    "remark": "Courier are not serviceable on pin codes.",
    "order_id": "1111111111",
    "order_created": true,
    "shipment": [
        {
            "awb_generated": false,
            "pickup_generated": true,
            "shipment_id": "1111111111",
            "awb_code": "",
            "courier_company_id": "",
            "parent_courier_name": "",
            "courier_name": "",
            "applied_weight": 0.0,
            "routing_code": "",
            "rto_routing_code": "",
            "pickup_token_number": "",
            "pickup_scheduled_date": "",
            "total_value": 100.0,
            "shipment_items": [
                {
                    "name": "ARPTEST0023",
                    "sku": "ARPTEST0023",
                    "units": 2,
                    "selling_price": 100.0
                }
            ]
        }
    ]
}

Task:​

Basic Information

Curl:​

Response:​

Task:

Curl:

Response: